CygNet FMS History Grid Control

History Grid Control icon The CygNet FMS History Grid Control is an ActiveX control used for viewing and editing measurement data. Each row of the grid displays data for a single selected device or station. Each column represents a category of data.

See Using the History Grid Control for more information about configuring and using this control.

See CxFmsHistoryGridCtrl Object in the Scripting section for more information about scripting this control.

Adding a History Grid Control to a Screen

To Add and Configure a CygNet FMS History Grid Control in CygNet Studio

  1. Create a new CygNet Studio screen.
  2. Click the ActiveX tool ActiveX on the Standard Tools palette.
  3. Click and drag the outline of a box on the screen. When the mouse button is released, an Insert OLE Control dialog box appears.
  4. In the dialog box, double-click on CygNet FMS History Grid Control to place a History Grid control on your screen.
  5. Right-click the control to open its property sheet.
  6. On the ActiveX page, click ... or double-click (OCXProperties) to access the CygNet FMS history Grid Control Properties dialog box.
  7. The CygNet FMS History Grid control contains a General tab, a Grid tab, and a Commands tab.
  8. Configure properties on each page as desired, click Apply, and then click OK.
  9. Close the property sheet, save, and then switch to Run mode to use the control.

General Properties

The General page of the CygNet FMS history Grid Control Properties dialog box contains the following properties.

General Properties

General Properties

Property Description
General

FMS service

Type the name of the Site.Service to which to connect in the control's Chooser, or click ... to access the Select Service dialog box.

Use Point in Time mode

Click the check box to select/clear the option to use the Point in Time mode.

PIT (C)

If Use Point in Time mode is selected, do one of the following.

  • Type the desired date/time value into the text box.
  • Click ... to access the Select Date and Time dialog box, then enter the date/time, in Contract time (C), from which you want to view data.

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

Use Session Node

Click the check box to select/clear the option to Use Session Node instead of using the chooser.

Default value is cleared.

Use Session options

Click the check box to select/clear the option to Use Session options instead of entering a time window and time format.

Default value is cleared.

Show Chooser pane

Click the check box to select/clear the option to display the Chooser pane in the control.

Default value is selected.

Show Options pane

Click the check box to select/clear the option to display the Options pane in the control.

Default value is selected.

Node Chooser

Allow FMS service selection

Click the check box to select/clear the option to show the FMS service selector in the control's Chooser.

Allow Node category selection

Click the check box to select/clear the option to show the Node category selector in the control's Chooser.

Category

Select the desired Node Category to display in the control's Chooser from the drop-down menu.

Options include the following, as applicable to the control.

  • Device
  • Gas Device
  • Liquid Device
  • Station

Group

Select the desired Node Group type to display in the control's Chooser from the drop-down menu.

Options are as follows.

  • All Nodes
  • General
  • Station
  • By Category

Filter

Select a filter.

First type a partial string of known Node name/description/ID characters to populate the filter text box in the control's Chooser. Wildcard values * (multiple character) and ? (single character) are supported.

Default value is * (multiple character wildcard) - all.

Note: Wildcards can be used only when filtering by Name or Desc, not when filtering by ID.

Then select a Node option to filter for results.

Options are as follows.

  • Name
  • Desc
  • ID

Primary column

Select the desired primary sort column in the control's Chooser from the drop-down menu.

Options include the following

  • Type ascending
  • Name ascending
  • Description ascending
  • Type descending
  • Name descending
  • Description descending

Default value is Name ascending

Date

Start

Date selections are in Contract days (C).

Enter the starting date (absolute or relative date) in the text box or click ... to access the Select Date dialog box.

See Selecting Date and Time for more information.

End

Date selections are in Contract days (C).

Enter the ending date (absolute or relative date) in the text box or click ... to access the Select Date dialog box.

See Selecting Date and Time for more information.

Format

Select the desired time format from the drop-down menu.

Options are as follows.

  • Device
  • Contract
  • Local

See Using the History Grid Control for more information about configuring these properties.

Grid Properties

The Grid page of the CygNet FMS History Grid Control Properties dialog box contains the following properties.

Grid Properties

Grid Properties

Property Description

Unit set

Select a Unit set in which to view the data.

Options appear in the drop-down menu, which is populated by the unit sets defined in the service, and includes a default unit set.

Refresh icon

Click to Refresh the available unit set list

Columns

Click ... to access the History Grid Columns dialog box to select columns for display in the control.

The data fields available to be viewed in the columns correspond to the data mode selected, and you can select the sets of columns to appear for each selection.

Options include data items corresponding to the following.

  • Gas Device
  • Liquid Device
  • Gas Station

See Using the History Grid Control for more information about using columns in the control.

Note: Custom columns listed are as configured via the Admin Options Custom Device Data page

See EFM Data Items for more information and lists of data items supported by CygNet Measurement.

Data mode

Click to select a Data mode from the drop-down menu, in which to view data for station meter Nodes.

Options are as follows.

  • Device
  • Station

Record span

Click to access the drop-down menu to select a Record span for display of history data.

Options are as follows.

  • Daily
  • Hourly
  • Native - appears for Device-level data only; not applicable to Station-level data

Default value is Native for Device data mode, Hourly for Station data mode.

Record order

Click to access the drop-down menu to select a Record order for display of history data.

Options are as follows.

  • Oldest first
  • Newest first

Default value is Oldest first.

Decimal precision

Click to select a Decimal precision for the display from the drop-down menu.

Options are from 0 - 10 decimal places.

Default value is 7.

Note: Although values are shown in the History Grid control with a decimal precision of up to 10 places, device Node values are shown in the Batch, Ticket, Liquid Device QTR, and Liquid Device Raw QTR reports with a decimal precision of 15 places.

Show units

Click the check box to select/clear display of data units in the grid, where applicable.

Default value is cleared (units not shown).

Color mode

Note: This property is made available for device data mode only; the option is disabled (appears dimmed) if Station data mode is selected for a station meter Node.

Click to access the drop-down menu to select a grid Color mode to use to visually identify problematic records by applying color to the data grid.

Options are as follows.

  • None
  • Row background
  • Row text
  • Date/Time background
  • Date/Time text

Default value is Row background.

Note: Grid color selections other than "None" will automatically apply color to records based on their Data Quality (primary precedence) or Data Source (secondary precedence) values. See Data Quality and Data Source in the CygNet Measurement Concepts topic for more information.

For grid element color options other than "None" you can optionally color records with low data quality values and/or record rows having, or data cells triggering, exceptions. To visually identify these problematic records, use the following Color data quality below option and/or elect to color identified rows or cells containing exception-generating data.

Color data quality below

Note: This property is made available for device data mode only; the option is disabled (appears dimmed) if Station data mode is selected for a station meter Node.

When a Color mode option other than "None" is selected, the Color data quality below menu becomes available.

Select a value from the options in the drop-down menu. Color will be applied to records with lower data quality than this selected value.

Default value is the data quality value configured in your system settings, using the Admin menu. See Configuring Data Quality Settings for more information.

Refresh icon

Click to Refresh the available "Color data quality below" options.

Color rows containing exceptions

Note: This property is made available for device data mode only; the option is disabled (appears dimmed) if Station data mode is selected for a station meter Node.

When a Color mode option other than "None" is selected, the Color rows containing exceptions check box becomes available.

Click the check box to select/clear the option to color record rows if they have exceptions.

Default value is selected (color record rows with exceptions).

Highlight cells causing exceptions

Note: This property is made available for device data mode only; the option is disabled (appears dimmed) if Station data mode is selected for a station meter Node.

When a Color mode option other than "None" is selected, the Highlight cells causing exceptions check box becomes available.

Click the check box to select/clear the option to highlight record cells if they contain data triggering exceptions.

Default value is selected (highlight cells causing exceptions).

See Using the History Grid Control for more information about configuring these properties.

Commands Properties

The Commands page of the CygNet FMS history Grid Control Properties dialog box contains the following options.

Commands Properties

Commands Properties

See Managing Node Commands for more information about configuring commands for the FMS History Grid control.


More:

Back to top